docs: add swidge protocol interface#136
Draft
ihsraham wants to merge 4 commits into
Draft
Conversation
|
Just want to clarify the use case of Swidge interface, its not just for providers who combine swap + bridge txn in one txn. At some places I see the definition written as its only for swap + bridge txn, but thats not true and it should be corrected. It can be used by 3 types of providers/txns:
Swidge also supports any type of route between different tokens and different chains. |
Contributor
Author
|
addressed in 67bf7d8. updated the swidge wording across the docs, changelog, and skill references so it covers swap-only, bridge-only, and combined swap and bridge routes. also added local preview and validation instructions to the README. |
Remove the dynamic /llms-full.txt route because it conflicts with the tracked public asset in Next dev and can return a 500 page to the copy action. Pin react and react-dom to the same exact version so local preview does not install mismatched React packages. Guard the LLM copy action so failed fetch responses are not copied as valid docs content.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/llms-full.txtlocal preview and copy behavior by serving the tracked static artifact, removing the conflicting dynamic route, pinning matching React versions, and preventing failed fetch responses from being copied as docs content.Validation
git diff --checknpm run check:metaLINK_CHECK_EXTERNAL=false npm run check:linksnpm run buildcurl http://localhost:3001/llms-full.txtreturns200 text/plainand includes the swidge section.Notes
quoteSwidge,executeSwidge, andgetSwidgeStatus.getSupportedAssetsorgetSupportedChainsas available because they are not present in the linked implementation yet.public/llms-full.txtandsrc/app/llms-full.txt/route.tshandled the same path, which could cause the copy action to copy a 500 response body.